home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / crt / ds3100.md / alloca.c < prev    next >
C/C++ Source or Header  |  1989-09-29  |  5KB  |  172 lines
  1. /*
  2.     alloca -- (mostly) portable public-domain implementation -- D A Gwyn
  3.  
  4.     This implementation of the PWB library alloca() function,
  5.     which is used to allocate space off the run-time stack so
  6.     that it is automatically reclaimed upon procedure exit, 
  7.     was inspired by discussions with J. Q. Johnson of Cornell.
  8.  
  9.     It should work under any C implementation that uses an
  10.     actual procedure stack (as opposed to a linked list of
  11.     frames).  There are some preprocessor constants that can
  12.     be defined when compiling for your specific system, for
  13.     improved efficiency; however, the defaults should be okay.
  14.  
  15.     The general concept of this implementation is to keep
  16.     track of all alloca()-allocated blocks, and reclaim any
  17.     that are found to be deeper in the stack than the current
  18.     invocation.  This heuristic does not reclaim storage as
  19.     soon as it becomes invalid, but it will do so eventually.
  20.  
  21.     As a special case, alloca(0) reclaims storage without
  22.     allocating any.  It is a good idea to use alloca(0) in
  23.     your main control loop, etc. to force garbage collection.
  24. */
  25.  
  26. #include <stdio.h>
  27. #include <stdlib.h>
  28.  
  29. #ifdef ds3100
  30. #define STACK_DIRECTION (-1)
  31. #endif
  32.  
  33. #ifdef __STDC__
  34. typedef void    *pointer;        /* generic pointer type */
  35. #else
  36. typedef char    *pointer;        /* generic pointer type */
  37. #endif
  38.  
  39. /*
  40.     Define STACK_DIRECTION if you know the direction of stack
  41.     growth for your system; otherwise it will be automatically
  42.     deduced at run-time.
  43.  
  44.     STACK_DIRECTION > 0 => grows toward higher addresses
  45.     STACK_DIRECTION < 0 => grows toward lower addresses
  46.     STACK_DIRECTION = 0 => direction of growth unknown
  47. */
  48.  
  49. #ifndef STACK_DIRECTION
  50. #define    STACK_DIRECTION    0        /* direction unknown */
  51. #endif
  52.  
  53. #if STACK_DIRECTION != 0
  54.  
  55. #define    STACK_DIR    STACK_DIRECTION    /* known at compile-time */
  56.  
  57. #else    /* STACK_DIRECTION == 0; need run-time code */
  58.  
  59. static int    stack_dir;        /* 1 or -1 once known */
  60. #define    STACK_DIR    stack_dir
  61.  
  62. static void
  63. find_stack_direction (/* void */)
  64. {
  65.   static char    *addr = NULL;    /* address of first
  66.                    `dummy', once known */
  67.   auto char    dummy;        /* to get stack address */
  68.  
  69.   if (addr == NULL)
  70.     {                /* initial entry */
  71.       addr = &dummy;
  72.  
  73.       find_stack_direction ();    /* recurse once */
  74.     }
  75.   else                /* second entry */
  76.     if (&dummy > addr)
  77.       stack_dir = 1;        /* stack grew upward */
  78.     else
  79.       stack_dir = -1;        /* stack grew downward */
  80. }
  81.  
  82. #endif    /* STACK_DIRECTION == 0 */
  83.  
  84. /*
  85.     An "alloca header" is used to:
  86.     (a) chain together all alloca()ed blocks;
  87.     (b) keep track of stack depth.
  88.  
  89.     It is very important that sizeof(header) agree with malloc()
  90.     alignment chunk size.  The following default should work okay.
  91. */
  92.  
  93. #ifndef    ALIGN_SIZE
  94. #define    ALIGN_SIZE    sizeof(double)
  95. #endif
  96.  
  97. typedef union hdr
  98. {
  99.   char    align[ALIGN_SIZE];    /* to force sizeof(header) */
  100.   struct
  101.     {
  102.       union hdr *next;        /* for chaining headers */
  103.       char *deep;        /* for stack depth measure */
  104.     } h;
  105. } header;
  106.  
  107. /*
  108.     alloca( size ) returns a pointer to at least `size' bytes of
  109.     storage which will be automatically reclaimed upon exit from
  110.     the procedure that called alloca().  Originally, this space
  111.     was supposed to be taken from the current stack frame of the
  112.     caller, but that method cannot be made to work for some
  113.     implementations of C, for example under Gould's UTX/32.
  114. */
  115.  
  116. static header *last_alloca_header = NULL; /* -> last alloca header */
  117.  
  118. pointer
  119. alloca (size)            /* returns pointer to storage */
  120.      unsigned    size;        /* # bytes to allocate */
  121. {
  122.   auto char    probe;        /* probes stack depth: */
  123.   register char    *depth = &probe;
  124.  
  125. #if STACK_DIRECTION == 0
  126.   if (STACK_DIR == 0)        /* unknown growth direction */
  127.     find_stack_direction ();
  128. #endif
  129.  
  130.         /* Reclaim garbage, defined as all alloca()ed storage that
  131.            was allocated from deeper in the stack than currently. */
  132.  
  133.   {
  134.     register header    *hp;    /* traverses linked list */
  135.  
  136.     for (hp = last_alloca_header; hp != NULL;)
  137.       if (STACK_DIR > 0 && hp->h.deep > depth
  138.       || STACK_DIR < 0 && hp->h.deep < depth)
  139.     {
  140.       register header    *np = hp->h.next;
  141.  
  142.       free ((pointer) hp);    /* collect garbage */
  143.  
  144.       hp = np;        /* -> next header */
  145.     }
  146.       else
  147.     break;            /* rest are not deeper */
  148.  
  149.     last_alloca_header = hp;    /* -> last valid storage */
  150.   }
  151.  
  152.   if (size == 0)
  153.     return NULL;        /* no allocation required */
  154.  
  155.   /* Allocate combined header + user data storage. */
  156.  
  157.   {
  158.     register pointer    new = malloc (sizeof (header) + size);
  159.     /* address of header */
  160.  
  161.     ((header *)new)->h.next = last_alloca_header;
  162.     ((header *)new)->h.deep = depth;
  163.  
  164.     last_alloca_header = (header *)new;
  165.  
  166.     /* User storage begins just after header. */
  167.  
  168.     return (pointer)((char *)new + sizeof(header));
  169.   }
  170. }
  171.  
  172.